Skip to content

feat(documentation): reorganize the whole documentation #3055

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 10 commits into
base: ouds/main
Choose a base branch
from
Open

feat(documentation): reorganize the whole documentation #3055

wants to merge 10 commits into from

Conversation

@louismaximepiton
Copy link
Member

@louismaximepiton louismaximepiton commented Jul 7, 2025 •
edited
Loading

Note: Please transform - [ ] into - (NA) in the description when things are not applicable

Related issues

Closes #3018
Edit #2901 once this PR is merged

Description

Change the whole documentation according to what we decided all together.

If a page is changed or renamed, please check:

  • Search for category/ rather than /category
  • That the page should be singular or plural
  • That there is no conflict with a similar page in the section
  • That the links to this page are updated
  • That the aliases are updated
  • That the sitemap has been updated
  • That the component is still in the Storybook generation
  • That the title is updated accordingly

Motivation & Context

Better comprehension for users and take the complexity on our side.

Types of change

  • New feature (non-breaking change which adds functionality)

Live previews

Checklist

Contribution

Accessibility

  • My change follows accessibility good practices; I have at least run axe

Design

  • My change respects the design guidelines defined in Orange Design System
  • My change is compatible with a responsive display

Development

  • My change follows the developer guide
  • I have added JavaScript unit tests to cover my changes
  • I have added SCSS unit tests to cover my changes

Documentation

  • My change introduces changes to the documentation and/or I have updated the documentation accordingly

Checklist (for Core Team only)

  • My change introduces changes to the migration guide
  • My new component is well displayed in Storybook
  • My new component is compatible with RTL
  • Manually run BrowserStack tests
  • Manually test browser compatibility with BrowserStack (Chrome >= 60, Firefox >= 60 (+ ESR), Edge, Safari >= 12, iOS Safari, Chrome & Firefox on Android)
  • Code review
  • Design review
  • A11y review

After the merge

@louismaximepiton louismaximepiton added the 📖 documentation Improvements or additions to documentation label Jul 7, 2025
@netlify
Copy link

netlify bot commented Jul 7, 2025 •
edited
Loading

✅ Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 0f55a1a
🔍 Latest deploy log https://app.netlify.com/projects/boosted/deploys/6891d320f7cee10008c76eaa
😎 Deploy Preview https://deploy-preview-3055--boosted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@louismaximepiton louismaximepiton marked this pull request as ready for review July 8, 2025 08:31
@boosted-bot boosted-bot moved this from In Progress / Draft to Need Dev Review in 🟣 [Orange-Boosted-Bootstrap] PRs Board Jul 8, 2025
@louismaximepiton louismaximepiton linked an issue Jul 8, 2025 that may be closed by this pull request
[OUDS] Reorganize the documentation #3018
Open
2 tasks
@hannahiss
Copy link
Member

hannahiss commented Jul 9, 2025

Why not, on the homepage, add another button near "read the docs" to lead directly to components ? (or replace the button wuth "read the components doc")

@hannahiss
Copy link
Member

hannahiss commented Jul 9, 2025

Maybe in the docs tab, in the left menu,

  • rename Concept in Components by category (or something like that)
  • just keep this entry and not the "components" entry (since we already have the components by category, and the whole list in the components tab)

@louismaximepiton
Copy link
Member Author

louismaximepiton commented Jul 10, 2025 •
edited
Loading 

* just keep this entry and not the "components" entry (since we already have the components by category, and the whole list in the components tab)

Not quite sure to understand, do you mean the navbar link in the header should be removed ? If yes, where should the homepage button redirect ?

@louismaximepiton
Copy link
Member Author

louismaximepiton commented Jul 16, 2025

So as far as I understood, the idea is to remove the left menu Components part to insert it in some way inside the Components categories part, maybe via dropdowns or accordions.

@louismaximepiton
Copy link
Member Author

louismaximepiton commented Jul 16, 2025

@vprothais
Copy link
Collaborator

vprothais commented Jul 16, 2025

My understanding of Hannah's proposal is to completely remove the component list from the vertical menu, since we can find them in each category and through the component entry from the horizontal menu.

Doing that would add 1 click for users in order to navigate from one component to an other. The component categories and and component list are a bit redundant but I don't see it as a problem, the understanding of "component categories" could be improved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

📖 documentation Improvements or additions to documentation

Projects

🟣 [Orange-Boosted-Bootstrap] PRs Board
Status: Need Dev Review

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[OUDS] Reorganize the documentation

3 participants

@louismaximepiton @hannahiss @vprothais